🩹 [Patch]: Add Linter settings + fix documentation structure #535

MariusStorhaug · 2025-10-06T13:36:58Z

Description

This pull request primarily fixes the documentation of PowerShell functions by adding PowerShell-formatted code blocks to the .EXAMPLE sections, due to upgrading from platyPS to Microsoft.PowerShell.PlatyPS. Additionally, it introduces configuration changes for linters and minor formatting corrections.

Documentation improvements:

Added PowerShell-formatted code blocks to the .EXAMPLE sections of many function files in src/functions/*. This was needed to retain the code blocks in the examples, as Microsoft.PowerShell.PlatyPS lets the user configure this.

Linter and configuration updates:

Added a Linter section to .github/PSModule.yml to explicitly disable several validation checks, such as VALIDATE_BIOME_FORMAT and VALIDATE_POWERSHELL.
Fixed a minor formatting issue in .github/linters/.markdown-lint.yml by changing double quotes to single quotes for the MD026.punctuation setting. This was also due to Microsoft.PowerShell.PlatyPS adding H3 for types which can be same for .INPUTS and .OUTPUTS.

Encoding and formatting corrections:

Added or corrected UTF-8 BOM in some PowerShell files to ensure proper encoding.

…PSModule.yml

Copilot

Pull Request Overview

This PR adds linter configuration settings to disable multiple validation checks in the project's PSModule configuration. The changes focus on disabling various formatting and linting tools to adjust the project's code quality enforcement.

Adds a new Linter section with environment variable configurations
Disables seven different linter validation checks including Biome, GitHub Actions Zizmor, JSCPD, and Prettier variants

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

…bles in PSModule.yml

Copilot

Pull Request Overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

…lity

…tHubLogGroup functions; add detailed descriptions and examples

Copilot

Pull Request Overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

src/functions/public/Workflows/Enable-GitHubWorkflow.ps1

…GitHub functions to enhance usability and clarity

- Added code examples in the documentation for various GitHub user key management functions including: - Remove-GitHubUserKey - Add-GitHubUserSigningKey - Get-GitHubUserSigningKey - Remove-GitHubUserSigningKey - Add-GitHubUserSocial - Remove-GitHubUserSocial - Update-GitHubUser - Export-GitHubVariable - Get-GitHubVariable - New-GitHubVariable - Remove-GitHubVariable - Add-GitHubVariableSelectedRepository - Get-GitHubVariableSelectedRepository - Remove-GitHubVariableSelectedRepository - Set-GitHubVariableSelectedRepository - Set-GitHubVariable - Update-GitHubVariable - Get-GitHubAppWebhookConfiguration - Get-GitHubAppWebhookDelivery - Invoke-GitHubAppWebhookReDelivery - Test-GitHubWebhookSignature - Update-GitHubAppWebhookConfiguration - Disable-GitHubWorkflow - Enable-GitHubWorkflow - Get-GitHubWorkflow - Get-GitHubWorkflowRun - Remove-GitHubWorkflowRun - Restart-GitHubWorkflowRun - Stop-GitHubWorkflowRun - Start-GitHubWorkflow - New-FunctionTemplate - Removed invisible characters from function definitions to ensure compatibility.

…shell' syntax highlighting for improved clarity

Copilot

Pull Request Overview

Copilot reviewed 300 out of 335 changed files in this pull request and generated 17 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

src/functions/public/Users/Emails/Remove-GitHubUserEmail.ps1

src/functions/public/Users/Emails/Add-GitHubUserEmail.ps1

src/functions/public/Repositories/Update-GitHubRepository.ps1

src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTopic.ps1

src/functions/public/Commands/Stop-GitHubLogGroup.ps1

src/functions/public/Commands/Start-GitHubLogGroup.ps1

src/functions/private/Core/ConvertTo-GitHubGraphQLField.ps1

src/functions/private/Commands/ConvertFrom-GitHubOutput.ps1

…unctions

Copilot

Pull Request Overview

Copilot reviewed 300 out of 335 changed files in this pull request and generated 6 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

src/functions/public/Users/GPG-Keys/Remove-GitHubUserGpgKey.ps1

src/functions/public/Repositories/Update-GitHubRepository.ps1

src/functions/public/Repositories/Permissions/Get-GitHubRepositoryPermission.ps1

src/functions/public/Issues/ConvertFrom-IssueForm.ps1

src/functions/private/Commands/ConvertFrom-GitHubOutput.ps1

.github/PSModule.yml

… clarity

Copilot

Pull Request Overview

Copilot reviewed 300 out of 335 changed files in this pull request and generated 6 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

src/functions/public/Users/GPG-Keys/Add-GitHubUserGpgKey.ps1

src/functions/public/Repositories/Update-GitHubRepository.ps1

src/functions/public/Repositories/Permissions/Get-GitHubRepositoryPermission.ps1

src/functions/public/Commands/Stop-GitHubLogGroup.ps1

src/functions/public/Commands/Start-GitHubLogGroup.ps1

src/functions/private/Commands/ConvertFrom-GitHubOutput.ps1

…ByTeam, Get-GitHubSecretOwnerList, Get-GitHubRepositoryPermission, Get-GitHubRepositoryTopic, and Set-GitHubVariableSelectedRepository functions

….ps1

Copilot

Pull Request Overview

Copilot reviewed 300 out of 336 changed files in this pull request and generated 1 comment.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

src/functions/private/Commands/ConvertFrom-GitHubOutput.ps1

github-actions · 2025-10-14T15:38:11Z

Module GitHub - 0.40.4 published to the PowerShell Gallery.

github-actions · 2025-10-14T15:38:13Z

GitHub release for GitHub v0.40.4 has been created.

🩹 [Patch]: Add Linter environment variables for validation checks in …

5bd31f2

…PSModule.yml

MariusStorhaug self-assigned this Oct 6, 2025

MariusStorhaug requested a review from a team as a code owner October 6, 2025 13:36

Copilot AI review requested due to automatic review settings October 6, 2025 13:36

github-project-automation bot added this to GitHub PowerShell Module Oct 6, 2025

github-project-automation bot moved this to Todo in GitHub PowerShell Module Oct 6, 2025

Copilot AI reviewed Oct 6, 2025

View reviewed changes

MariusStorhaug added 2 commits October 6, 2025 16:15

🩹 [Patch]: Add VALIDATE_POWERSHELL option to Linter environment varia…

4bb946a

…bles in PSModule.yml

Fix Docs

3c1dfdc

Copilot AI review requested due to automatic review settings October 6, 2025 20:37

Copilot AI reviewed Oct 6, 2025

View reviewed changes

🩹 [Patch]: Clean up comments in .markdown-lint.yml for better readabi…

9e90d3c

…lity

MariusStorhaug added the patch label Oct 12, 2025

🩹 [Patch]: Enhance documentation for Start-GitHubLogGroup and Stop-Gi…

5571919

…tHubLogGroup functions; add detailed descriptions and examples

Copilot AI review requested due to automatic review settings October 12, 2025 08:40

Copilot AI reviewed Oct 12, 2025

View reviewed changes

src/functions/public/Workflows/Enable-GitHubWorkflow.ps1 Outdated Show resolved Hide resolved

src/functions/public/Workflows/Enable-GitHubWorkflow.ps1 Outdated Show resolved Hide resolved

MariusStorhaug added 5 commits October 12, 2025 11:28

🩹 [Patch]: Add PowerShell code examples to documentation for various …

e561045

…GitHub functions to enhance usability and clarity

🩹 [Patch]: Update code examples in PowerShell functions to use 'power…

ebf18e3

…shell' syntax highlighting for improved clarity

Fix

9b52d34

Convert to UTF8withBom

2415382

Copilot AI review requested due to automatic review settings October 12, 2025 10:33

Copilot AI reviewed Oct 12, 2025

View reviewed changes

MariusStorhaug added 2 commits October 12, 2025 12:46

Fix formatting in documentation for Enable-GitHubWorkflow function

6728269

Fix formatting in documentation examples across multiple PowerShell f…

5b21d8d

…unctions

Copilot AI review requested due to automatic review settings October 12, 2025 13:33

Copilot AI reviewed Oct 12, 2025

View reviewed changes

Fix formatting in ConvertFrom-GitHubOutput documentation examples for…

86c7851

… clarity

MariusStorhaug requested a review from Copilot October 12, 2025 13:55

Copilot AI reviewed Oct 12, 2025

View reviewed changes

MariusStorhaug added 2 commits October 12, 2025 16:22

Fix formatting in documentation examples for Get-GitHubRepositoryList…

79527f3

…ByTeam, Get-GitHubSecretOwnerList, Get-GitHubRepositoryPermission, Get-GitHubRepositoryTopic, and Set-GitHubVariableSelectedRepository functions

Remove 'Flaky' tag from SelectedRepository context in Variables.Tests…

223c613

….ps1

Copilot AI review requested due to automatic review settings October 12, 2025 20:13

Copilot AI reviewed Oct 12, 2025

View reviewed changes

src/functions/private/Commands/ConvertFrom-GitHubOutput.ps1 Show resolved Hide resolved

Add 'Flaky' tag to SelectedRepository context in Variables.Tests.ps1

cd916da

MariusStorhaug merged commit a11a390 into main Oct 14, 2025
144 of 147 checks passed

MariusStorhaug deleted the fixDocs branch October 14, 2025 09:30

github-project-automation bot moved this from Todo to Done in GitHub PowerShell Module Oct 14, 2025

MariusStorhaug deployed to github-pages October 14, 2025 15:37 — with GitHub Actions View deployment

🩹 [Patch]: Add Linter settings + fix documentation structure #535

🩹 [Patch]: Add Linter settings + fix documentation structure #535

Uh oh!

Conversation

MariusStorhaug commented Oct 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Oct 14, 2025

Uh oh!

github-actions bot commented Oct 14, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

MariusStorhaug commented Oct 6, 2025 •

edited

Loading